home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 42 / Amiga Format AFCD42 (Issue 126, Aug 1999).iso / -serious- / emulation / uae-app / uae-app_015.readme < prev    next >
Text File  |  1999-05-14  |  14KB  |  267 lines
  1. Short:    UAE-ADF Mount+Unmount Workbench-Interface
  2. Author:   hippie@cheerful.com  [ Ralf Steines AKA Hippie2000 ]
  3. Uploader: hippie@cheerful.com  [ Ralf Steines AKA Hippie2000 ]
  4. Type:     misc/emu
  5. Replaces: misc/emu/uae-app_014*
  6.  
  7. $VER: UAE-App 0.1.5 by Hippie2000
  8.  
  9. UAE-ADF Mount+Unmount Workbench-Interface
  10.  
  11. What's New?
  12.  
  13.     As of version 0.1.5, the program will no longer be launched from WBStartup.
  14.     The executable is called "UA" now for good, and its location is C: from now on.
  15.     A new command "ua startup" was added to launch the server from user-startup.
  16.     Configuration no longer comes from the icon tooltypes, but from environment vars,
  17.     which get created/modified by a comfortable installer script. The installer script
  18.     preserves existing configuration from now on, just this time you will have to enter
  19.     hostpath and hostslash again. UAE-App is now availlable in two versions, the
  20.     normal one which just contains all my work, and the "fat" version which includes
  21.     all optional files, to allow an "installation in one go" with just answering two
  22.     questions. The documentation has been improved, and an amigaguide version has
  23.     been included, with basic online help features in the GUI.
  24.  
  25. Introduction
  26.  
  27.     UAE-App is a Commodity integrating the DF0: - DF3: ADF disk emulation control
  28.     of UAE in the Amiga-OS. It provides the entire scale of Amiga User-Interfaces,
  29.     to make ADF disk emulation handling as simple as possible. A popup GUI for all
  30.     functions is provided, as well as a shell scripting interface. Archiving and
  31.     dearchiving functions are implemented to handle gzip/zip/dms compressed disk
  32.     images with or without GUI.
  33.  
  34. Requirements
  35.  
  36.     UAE-App requires at least V37 of the Amiga-OS (Kick 2.04/Workbench 2.04),
  37.     running on any port of UAE which allows to mount parts of the native host
  38.     filesystem as amiga volumes. It was successfully tested with recent Windows,
  39.     Linux, Mac and Amiga ports of UAE. UAE-App does not require any special
  40.     libraries, just those which are part of the AmigaOS. However, if you want
  41.     to enable the optional archiving support functions you need to have the
  42.     GZip/UnZip/xDMS executables in your C: directory and of course ixemul.library
  43.     in your libs: folder. If you do not already have these files present, you should
  44.     consider to download the "fat" version, which contains them all.
  45.     (See "Download" below)
  46.  
  47. Download
  48.  
  49.     http://metamonk.com/uae-app/uae-app_015.lha
  50.     http://metamonk.com/uae-app/uae-app_015.readme
  51.     http://metamonk.com/uae-app/uae-app_015_fat.lha
  52.  
  53. Installation
  54.  
  55.     IMPORTANT: If you do not already have UAE-App 0.1.4 and its optional files
  56.     on your system, you should download the "fat" version of UAE-App, since it
  57.     contains all necessary compression utilities with a common installer script,
  58.     doing all in one go. (see "Download" section above). The fat version is not
  59.     spread through aminet, so if you got this archive from aminet you should go
  60.     to http://metamonk.com/uae-app/ to get the latest fat version of UAE-App.
  61.     
  62.     1) Mount a new volume "ADF:" using the UAE-GUI or UAE commandline-arguments.
  63.     This must be a native-filesystem harddisk emulation, no harddisk image!
  64.     Put all your ADF images there and start UAE to check if the new volume
  65.     appears on your workbench.
  66.     
  67.     2) Unpack the UAE-App archive in a temporary folder and double click the
  68.     "Install" icon. The installation script will prompt you to anwer two questtions
  69.     about the new volume "ADF:" which you have mounted before. First you will get
  70.     asked for the path of the mounted directory within your host filesystem. Sample
  71.     answer is "D:\amiga\adf\". Make sure that this path ends in a delimiter!
  72.     Next you will have to enter the slash character used in your host filesystem
  73.     to divide directorynames from filenames within pathes. Sample answer is "\".
  74.     That's all. Once installation is finished UAE-App will be launched automatically
  75.     so you will not have to reboot.
  76.     
  77.     Note: The installation script automatically shuts down your old UAE-App server
  78.     (if it is running). Whenever you want to change the settings of your UAE-App
  79.     installation you just need to run the installation script again. You do not
  80.     need to enter all information again, since it will be retrieved from your
  81.     current settings.
  82.  
  83. GUI Usage
  84.  
  85.     GUI POPUP WINDOW
  86.     
  87.     UAE-App normally hides its GUI until you call an ADF disk insertion function
  88.     by one of the interfaces described below. The GUI will pop up, showing you the
  89.     path of the ADF image you want to insert, enabling the buttons "Insert 0" to
  90.     "Insert 3". Click one of them and the virtual disk will be inserted in the
  91.     appropriate drive. Or click "Ignore", and the last insertion event will be
  92.     ignored. ADF disk insertion is limited files matching the insertion pattern
  93.     within the volume "ADF:". Anything else you may attempt to insert will just
  94.     flash your workbench screen.
  95.     
  96.     APP INTERFACE (DRAG AND DROP )
  97.     
  98.     UAE-App enables the complete Workbench App-Interface to trigger ADF disk
  99.     insertion and removal operations. Dragging an ADF image file in the Workench-
  100.     App-Icon or the Popup-GUI or activating the file and using the App-MenuItem
  101.     will call the disk insertion function (ADF file does not need to have an icon
  102.     for this). Dragging a disk icon associated with a DFx: virtual floppy drive
  103.     in the Workbench-App-Icon or the Popup-GUI or activating it and using the
  104.     App-MenuItem will call the disk removal function in turn.
  105.     
  106.     DEFAULT TOOL INTERFACE
  107.     
  108.     You may create Project Icons for your ADF image files, pointing at "c:ua" as
  109.     default tool. This will enable you to insert ADF images by double-clicking
  110.     at them, and MAY be the future interface to store UAE settings within the
  111.     Workbench tooltypes of each ADF image. (TODO?)
  112.     
  113.     SHUTTING DOWN UAE-APP
  114.     
  115.     You do not want to do this, do you? OK! Use Commodities Exchange, or use "Quit"
  116.     in the GUI's "Project" menu, or send a Ctrl-F to the ua process to shut down the
  117.     server. This will disable all functionality of UAE-App, even the shell interface
  118.     and the default tool interface. Relaunch UAE-App to enable all features again.
  119.  
  120. Shell Usage
  121.  
  122.     The executable is called "ua" and resides in your C: directory. It has an easy to
  123.     use shell interface to all functions the GUI provides. The syntax is very simple,
  124.     all keywords are the same ones as used in the GUI. The shell interface runs from
  125.     a separate process, controlling the server in remote. The GUI, part of the server,
  126.     may be used as a realtime monitor to all actions you trigger. All UAE-APP shell
  127.     operations which provide a destination drive (eg "DF0:") WAIT for the action to be
  128.     finished. The GUI (if opened) shows an asterisk (*) in front of the filename display
  129.     of each drive to monitor the wait state. If the wait state blocks for some reason
  130.     (eg a bug) you may use the PRELIMARY menu "beta hacks->clear wait flags" to unblock
  131.     it again. Please try to find out what happened and send me a bug report. Here's the
  132.     complete list of shell commands:
  133.     
  134.     ua insert <adffile> [<drive>]
  135.     ua remove <drive>
  136.     
  137.     ua create <adffile> [<drive>]
  138.     ua delete <adffile>
  139.     
  140.     ua gzip <adffile> [<drive>]
  141.     ua unpack <archive> [<drive>]
  142.     ua test <archive> [<drive>]
  143.     
  144.     ua reset
  145.     ua hardreset
  146.     ua debug
  147.     ua quituae
  148.     
  149.     ua popup
  150.     ua hide
  151.     ua quitapp
  152.     ua startup
  153.  
  154. Technical info
  155.  
  156.     UAE-App is a hybrid single executable solution. The first instance is launched
  157.     from your user-startup. It acts as a server to handle all uaelib functions, the
  158.     GUI, the AppInterface and a remote message-port in asynchronous way. Any further
  159.     instances of UAE-App (as launched by the filerequesters, the default tool interface
  160.     or the shell interface) send their results to the server, to be inserted in the
  161.     action stream.....
  162.  
  163. Bugs-Warnings-Todo
  164.  
  165.     - No character translation in filenames yet (except slashes)
  166.     - Disk images are not locked yet when mounted
  167.     - Don't run mu